Analytic Suite Widget

When embedded in an application, the Analytic Suite widget enables users to display the distinct views available on the analyze side (i.e Summary, Table, Custom, and Metric views).

Before You Begin

• Review the Widget Quick Start Guide for an overview of the widget components.
• Obtain your unique API key. It was provided in the welcome email that you received when your Qrvey instance was created. For more information, see Frequently Asked Questions (FAQs).
• This widget supports using security tokens for secure authentication. For more information, see Embedding Widgets Using a Security Token.

Get the Helper Code

1. In Qrvey Composer, display the Analyze tab for the desired dataset.
2. Click the Embedding Options button in the upper right corner of the page. A dialog displays with an HTML tag, a JSON configuration object, and the Widget Launcher script tag.
3. Click Copy to copy the code, and then paste it into your preferred editor.

Embed the HTML tag

Identify where you would like this widget to display in your application, and then add the HTML tag in that location.

The HTML tag for this widget is:

<an-dashboard config="anSuiteConfig"></an-dashboard>

Embed the Widget Launcher Script Tag

Add the widget launcher script tag to your application. Note that this widget requires an additional script for proper support in all browsers.

For reference, the launcher script code is:

<script type="module" src="https://<WIDGETS_URL>/qrvey-an-widgets/an-dashboard/andashboard/andashboard.esm.js"></script>
<script nomodule src="https://<WIDGETS_URL>/qrvey-an-widgets/an-dashboard/andashboard/andashboard.js"></script>

Set Properties in the JSON Configuration Object

Define the JSON configuration object by starting with the script provided in the helper code, and then adding additional configuration properties as needed. The script provided contains only the required properties. For reference, an example is copied below. The helper code that you obtained above should include the unique values indicated with brackets (“<>”):

<script>
var anSuiteConfig = {
   "api_key": "<API_KEY>",
   "app_id": "<APP_ID>",
   "domain": "https://<your_qrvey_domain>",
   "user_id": "<USER_ID>",
   "qrveyid": "<QRVEY_ID>",
   "settings": {
      "view": "CUSTOM_VIEW"
   }
}
</script>

When complete, add the JSON configuration object to your application.

Configuration Object Properties

The following table lists the properties associated with this widget.

Property	Value	Required
api_key	String, Your organization’s unique API key required to access the Qrvey platform. Never expose your organization’s API key to external users. In Production environments, use a secure token (qv_token) to encrypt the API key.	Yes, if the qv_token is not provided
qv_token	String, A secure token encrypted via JWT to authenticate and authorize embedded widgets. Establishes a secure connection between the host application and the Qrvey system. For more information, see Embedding Widgets Using a Security Token.	Yes, if the api_key is not provided
app_id	String, ID of the Qrvey application containing the dashboard, report, automation, or web form.	Yes
domain	String, The base URL of your instance of the Qrvey platform.	Yes
user_id	String, ID of the Qrvey Composer user that owns the application that is being embedded. Optional: You can alternately specify the user ID in a Qrvey session cookie.	Yes, if the user_id is not included in a session cookie
clientid	String, Unique identifier for the tenant end user. Required for using the End User Personalization feature. The clientid must be set to a unique value for each tenant end user.	No
timezone	Object <TimezoneConfiguration>, Overrides the time zone setting in Qrvey Admin Center. For more information, see Configuring Time Zone Settings.	No
qrveyid	String, ID of the dataset being used.	Yes
settings	Object, general configuration in order to set some behaviors.	No
settings.view	String, determines the initial view to display and it accepts: SUMMARY_VIEW/MULTI_PANEL TABULAR_VIEW CUSTOM_VIEW METRIC_VIEW Default: MULTI_PANEL (alias for SUMMARY_VIEW)	No
settings.mode	String, determines displaying the complete layout or the views only. It depends on set view and it accepts: COMPLETE SIMPLE * Default: COMPLETE	No
settings.displayMode	String, changes the style and extends the layout onto the entire container. FULL NORMAL * Default: NORMAL	No
userFilters	Object, the filters object generated by the user. This will be applied in internal components to filter the data. I.e. AN Single Panel. {filters: <Filters Key Structure>} To see more info about filter structure, visit https://documenter.getpostman.com/view/1152381/TVejh9vP#5e81efdb-5e32-4fca-892f-090dc0388e33	No
themeid	String, theme ID to use in the component	No
settings.styles	Object, styles options object. These properties will extend from the current theme	No
settings.styles.chartsTitle	String, set the charts title color	No
settings.styles.chartsFontFamily	String, set the charts font family	No
settings.styles.axisDataLabels	String, set axis labels color in charts	No
settings.styles.dataLabels	String, color for data labels in charts	No
settings.styles.valuesMain	String, set color for axis ticks values in charts	No
settings.styles.chartsLegends	String, color for charts legends labels	No
settings.styles.chartsTooltips	String, color for charts tooltips	No
settings.styles.tableHeaderFont	String, set color for table header texts	No
settings.styles.chartsMain	String, set color for chart data points like bars, symbols and lines.	No
settings.styles.themePalette	Array, contains a maximum of 20 colors that will be used for chart data points.	No
custom_tokens	Object, contains a set of custom tokens, each of them in turn, receives an array of with the list of tokens. {<custom token 1>: [<token 1>: “token 1”, <token 2>: “token 2”]}	No
authenticatedSession.email	String, Specifies the email address to associate with the widget. If an address is not specified, exports are sent to the email address associated with the user ID.	No

Code Samples

The following samples demonstrate how this widget can be used in an HTML page.

Implementation	Description	Front-end Code	Back-end Code
Basic API Key	This sample uses a basic API key to embed an Analytic Suite widget. It does not encrypt the API key and is not suitable for production environments.	codepen	n/a